This file contains API for Power Step 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Data Structures
struct	powerstep2_t
	Power Step 2 Click context object. More...
struct	powerstep2_cfg_t
	Power Step 2 Click configuration object. More...

Macros
#define	POWERSTEP2_CMD_NOP 0x00
	Power Step 2 commands list.
#define	POWERSTEP2_CMD_SET_PARAM 0x00
#define	POWERSTEP2_CMD_GET_PARAM 0x20
#define	POWERSTEP2_CMD_RUN 0x50
#define	POWERSTEP2_CMD_STEP_CLOCK 0x58
#define	POWERSTEP2_CMD_MOVE 0x40
#define	POWERSTEP2_CMD_GO_TO 0x60
#define	POWERSTEP2_CMD_GO_TO_DIR 0x68
#define	POWERSTEP2_CMD_GO_UNTIL 0x82
#define	POWERSTEP2_CMD_RELEASE_SW 0x92
#define	POWERSTEP2_CMD_GO_HOME 0x70
#define	POWERSTEP2_CMD_GO_MARK 0x78
#define	POWERSTEP2_CMD_RESET_POS 0xD8
#define	POWERSTEP2_CMD_RESET_DEVICE 0xC0
#define	POWERSTEP2_CMD_SOFT_STOP 0xB0
#define	POWERSTEP2_CMD_HARD_STOP 0xB8
#define	POWERSTEP2_CMD_SOFT_HIZ 0xA0
#define	POWERSTEP2_CMD_HARD_HIZ 0xA8
#define	POWERSTEP2_CMD_GET_STATUS 0xD0
#define	POWERSTEP2_PARAM_GEN_ABS_POS 0x01
	Power Step 2 parameter register list.
#define	POWERSTEP2_PARAM_GEN_EL_POS 0x02
#define	POWERSTEP2_PARAM_GEN_MARK 0x03
#define	POWERSTEP2_PARAM_GEN_SPEED 0x04
#define	POWERSTEP2_PARAM_GEN_ACC 0x05
#define	POWERSTEP2_PARAM_GEN_DEC 0x06
#define	POWERSTEP2_PARAM_GEN_MAX_SPEED 0x07
#define	POWERSTEP2_PARAM_GEN_MIN_SPEED 0x08
#define	POWERSTEP2_PARAM_V_KVAL_HOLD 0x09
#define	POWERSTEP2_PARAM_C_TVAL_HOLD 0x09
#define	POWERSTEP2_PARAM_V_KVAL_RUN 0x0A
#define	POWERSTEP2_PARAM_C_TVAL_RUN 0x0A
#define	POWERSTEP2_PARAM_V_KVAL_ACC 0x0B
#define	POWERSTEP2_PARAM_C_TVAL_ACC 0x0B
#define	POWERSTEP2_PARAM_V_KVAL_DEC 0x0C
#define	POWERSTEP2_PARAM_C_TVAL_DEC 0x0C
#define	POWERSTEP2_PARAM_V_INT_SPEED 0x0D
#define	POWERSTEP2_PARAM_V_ST_SLP 0x0E
#define	POWERSTEP2_PARAM_C_T_FAST 0x0E
#define	POWERSTEP2_PARAM_V_FN_SLP_ACC 0x0F
#define	POWERSTEP2_PARAM_C_TON_MIN 0x0F
#define	POWERSTEP2_PARAM_V_FN_SLP_DEC 0x10
#define	POWERSTEP2_PARAM_C_TOFF_MIN 0x10
#define	POWERSTEP2_PARAM_V_K_THERM 0x11
#define	POWERSTEP2_PARAM_GEN_ADC_OUT 0x12
#define	POWERSTEP2_PARAM_GEN_OCD_TH 0x13
#define	POWERSTEP2_PARAM_V_STALL_TH 0x14
#define	POWERSTEP2_PARAM_GEN_FS_SPD 0x15
#define	POWERSTEP2_PARAM_GEN_STEP_MODE 0x16
#define	POWERSTEP2_PARAM_GEN_ALARM_EN 0x17
#define	POWERSTEP2_PARAM_GEN_GATECFG1 0x18
#define	POWERSTEP2_PARAM_GEN_GATECFG2 0x19
#define	POWERSTEP2_PARAM_V_CONFIG 0x1A
#define	POWERSTEP2_PARAM_C_CONFIG 0x1A
#define	POWERSTEP2_PARAM_GEN_STATUS 0x1B
#define	POWERSTEP2_GEN_ABS_POS_HOME 0x000000ul
	Power Step 2 parameter register settings.
#define	POWERSTEP2_GEN_ABS_POS_MASK 0x3FFFFFul
#define	POWERSTEP2_GEN_EL_POS_STEP_ZERO 0x0000
#define	POWERSTEP2_GEN_EL_POS_STEP_MASK 0x0180
#define	POWERSTEP2_GEN_EL_POS_MICROSTEP_ZERO 0x0000
#define	POWERSTEP2_GEN_EL_POS_MICROSTEP_MASK 0x007F
#define	POWERSTEP2_GEN_EL_POS_MASK 0x01FF
#define	POWERSTEP2_GEN_MARK_ZERO 0x000000ul
#define	POWERSTEP2_GEN_MARK_MASK 0x3FFFFFul
#define	POWERSTEP2_GEN_SPEED_MASK 0x0FFFFFul
#define	POWERSTEP2_GEN_ACC_14_55_STEP_S2 0x0001
#define	POWERSTEP2_GEN_ACC_29_1_STEP_S2 0x0002
#define	POWERSTEP2_GEN_ACC_101_85_STEP_S2 0x0007
#define	POWERSTEP2_GEN_ACC_1004_STEP_S2 0x0045
#define	POWERSTEP2_GEN_ACC_1004_STEP_S2 0x0045
#define	POWERSTEP2_GEN_ACC_2008_STEP_S2 0x008A
#define	POWERSTEP2_GEN_ACC_59575_541_STEP_S2 0x0FFF
#define	POWERSTEP2_GEN_ACC_MASK 0x0FFF
#define	POWERSTEP2_GEN_DEC_14_55_STEP_S2 0x0001
#define	POWERSTEP2_GEN_DEC_29_1_STEP_S2 0x0002
#define	POWERSTEP2_GEN_DEC_101_85_STEP_S2 0x0007
#define	POWERSTEP2_GEN_DEC_1004_STEP_S2 0x0045
#define	POWERSTEP2_GEN_DEC_2008_STEP_S2 0x008A
#define	POWERSTEP2_GEN_DEC_59575_541_STEP_S2 0x0FFF
#define	POWERSTEP2_GEN_DEC_MASK 0x0FFF
#define	POWERSTEP2_GEN_MAX_SPEED_15_25_STEP_S 0x0001
#define	POWERSTEP2_GEN_MAX_SPEED_30_5_STEP_S 0x0002
#define	POWERSTEP2_GEN_MAX_SPEED_305_STEP_S 0x0014
#define	POWERSTEP2_GEN_MAX_SPEED_991_25_STEP_S 0x0041
#define	POWERSTEP2_GEN_MAX_SPEED_15610_STEP_S 0x03FF
#define	POWERSTEP2_GEN_MAX_SPEED_MASK 0x03FF
#define	POWERSTEP2_GEN_MIN_SPEED_LSPD_OPT_LOW 0x0000
#define	POWERSTEP2_GEN_MIN_SPEED_LSPD_OPT_HIGH 0x1000
#define	POWERSTEP2_GEN_MIN_SPEED_LSPD_OPT_MASK 0x1000
#define	POWERSTEP2_GEN_MIN_SPEED_MIN_SPEED_0_STEP_S 0x0000
#define	POWERSTEP2_GEN_MIN_SPEED_MIN_SPEED_0_238_STEP_S 0x0001
#define	POWERSTEP2_GEN_MIN_SPEED_MIN_SPEED_0_476_STEP_S 0x0002
#define	POWERSTEP2_GEN_MIN_SPEED_MIN_SPEED_2_38_STEP_S 0x000A
#define	POWERSTEP2_GEN_MIN_SPEED_MIN_SPEED_976_3_STEP_S 0x0FFF
#define	POWERSTEP2_GEN_MIN_SPEED_MIN_SPEED_MASK 0x0FFF
#define	POWERSTEP2_GEN_MIN_SPEED_MASK 0x1FFF
#define	POWERSTEP2_GEN_ADC_OUT_MASK 0x1F
#define	POWERSTEP2_GEN_OCD_TH_31_25_MV 0x00
#define	POWERSTEP2_GEN_OCD_TH_62_5_MV 0x01
#define	POWERSTEP2_GEN_OCD_TH_93_75_MV 0x02
#define	POWERSTEP2_GEN_OCD_TH_281_25_MV 0x08
#define	POWERSTEP2_GEN_OCD_TH_531_25_MV 0x10
#define	POWERSTEP2_GEN_OCD_TH_1000_MV 0x1F
#define	POWERSTEP2_GEN_OCD_TH_MASK 0x1F
#define	POWERSTEP2_GEN_FS_SPD_BOOST_MODE_DISABLE 0x0000
#define	POWERSTEP2_GEN_FS_SPD_BOOST_MODE_ENABLE 0x0400
#define	POWERSTEP2_GEN_FS_SPD_BOOST_MODE_MASK 0x0400
#define	POWERSTEP2_GEN_FS_SPD_FS_SPD_7_63_STEP_S 0x0000
#define	POWERSTEP2_GEN_FS_SPD_FS_SPD_22_88_STEP_S 0x0001
#define	POWERSTEP2_GEN_FS_SPD_FS_SPD_38_13_STEP_S 0x0002
#define	POWERSTEP2_GEN_FS_SPD_FS_SPD_15617_STEP_S 0x03FF
#define	POWERSTEP2_GEN_FS_SPD_FS_SPD_MASK 0x03FF
#define	POWERSTEP2_GEN_FS_SPD_MASK 0x07FF
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_EN_DISABLE 0x00
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_EN_ENABLE 0x80
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_EN_MASK 0x80
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_SEL_FULL_STEP 0x00
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_SEL_HALF_STEP 0x10
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_SEL_QUARTER_STEP 0x20
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_SEL_1_OVER_8 0x30
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_SEL_1_OVER_16 0x40
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_SEL_1_OVER_32 0x50
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_SEL_1_OVER_64 0x60
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_SEL_1_OVER_128 0x70
#define	POWERSTEP2_GEN_STEP_MODE_SYNC_SEL_MASK 0x70
#define	POWERSTEP2_GEN_STEP_MODE_CM_VM_VOLTAGE 0x00
#define	POWERSTEP2_GEN_STEP_MODE_CM_VM_CURRENT 0x08
#define	POWERSTEP2_GEN_STEP_MODE_CM_VM_MASK 0x08
#define	POWERSTEP2_GEN_STEP_MODE_STEP_SEL_FULL_STEP 0x00
#define	POWERSTEP2_GEN_STEP_MODE_STEP_SEL_HALF_STEP 0x01
#define	POWERSTEP2_GEN_STEP_MODE_STEP_SEL_QUARTER_STEP 0x02
#define	POWERSTEP2_GEN_STEP_MODE_STEP_SEL_1_OVER_8 0x03
#define	POWERSTEP2_GEN_STEP_MODE_STEP_SEL_1_OVER_16 0x04
#define	POWERSTEP2_GEN_STEP_MODE_STEP_SEL_1_OVER_32 0x05
#define	POWERSTEP2_GEN_STEP_MODE_STEP_SEL_1_OVER_64 0x06
#define	POWERSTEP2_GEN_STEP_MODE_STEP_SEL_1_OVER_128 0x07
#define	POWERSTEP2_GEN_STEP_MODE_STEP_SEL_MASK 0x07
#define	POWERSTEP2_GEN_STEP_MODE_MASK 0xFF
#define	POWERSTEP2_GEN_ALARM_EN_CMD_ERROR_MASK 0x80
#define	POWERSTEP2_GEN_ALARM_EN_SW_ON_MASK 0x40
#define	POWERSTEP2_GEN_ALARM_EN_STALL_DET_MASK 0x20
#define	POWERSTEP2_GEN_ALARM_EN_ADC_UVLO_MASK 0x10
#define	POWERSTEP2_GEN_ALARM_EN_UVLO_MASK 0x08
#define	POWERSTEP2_GEN_ALARM_EN_THERMAL_WARN_MASK 0x04
#define	POWERSTEP2_GEN_ALARM_EN_THERMAL_SD_MASK 0x02
#define	POWERSTEP2_GEN_ALARM_EN_OVERCURRENT_MASK 0x01
#define	POWERSTEP2_GEN_ALARM_EN_MASK 0xFF
#define	POWERSTEP2_GEN_GATECFG1_WD_EN_DISABLE 0x0000
#define	POWERSTEP2_GEN_GATECFG1_WD_EN_ENABLE 0x0800
#define	POWERSTEP2_GEN_GATECFG1_WD_EN_MASK 0x0800
#define	POWERSTEP2_GEN_GATECFG1_TBOOST_0_NS 0x0000
#define	POWERSTEP2_GEN_GATECFG1_TBOOST_62_5_NS 0x0100
#define	POWERSTEP2_GEN_GATECFG1_TBOOST_1000_NS 0x0700
#define	POWERSTEP2_GEN_GATECFG1_TBOOST_MASK 0x0700
#define	POWERSTEP2_GEN_GATECFG1_IGATE_4_MA 0x0020
#define	POWERSTEP2_GEN_GATECFG1_IGATE_8_MA 0x0040
#define	POWERSTEP2_GEN_GATECFG1_IGATE_16_MA 0x0060
#define	POWERSTEP2_GEN_GATECFG1_IGATE_24_MA 0x0080
#define	POWERSTEP2_GEN_GATECFG1_IGATE_32_MA 0x00A0
#define	POWERSTEP2_GEN_GATECFG1_IGATE_64_MA 0x00C0
#define	POWERSTEP2_GEN_GATECFG1_IGATE_96_MA 0x00E0
#define	POWERSTEP2_GEN_GATECFG1_IGATE_MASK 0x00E0
#define	POWERSTEP2_GEN_GATECFG1_TCC_125_NS 0x0000
#define	POWERSTEP2_GEN_GATECFG1_TCC_250_NS 0x0001
#define	POWERSTEP2_GEN_GATECFG1_TCC_375_NS 0x0002
#define	POWERSTEP2_GEN_GATECFG1_TCC_500_NS 0x0003
#define	POWERSTEP2_GEN_GATECFG1_TCC_3750_NS 0x001D
#define	POWERSTEP2_GEN_GATECFG1_TCC_MASK 0x001F
#define	POWERSTEP2_GEN_GATECFG1_MASK 0x0FFF
#define	POWERSTEP2_GEN_GATECFG2_TBLANK_125_NS 0x00
#define	POWERSTEP2_GEN_GATECFG2_TBLANK_250_NS 0x20
#define	POWERSTEP2_GEN_GATECFG2_TBLANK_375_NS 0x40
#define	POWERSTEP2_GEN_GATECFG2_TBLANK_1000_NS 0xE0
#define	POWERSTEP2_GEN_GATECFG2_TBLANK_MASK 0xE0
#define	POWERSTEP2_GEN_GATECFG2_TDT_125_NS 0x00
#define	POWERSTEP2_GEN_GATECFG2_TDT_250_NS 0x01
#define	POWERSTEP2_GEN_GATECFG2_TDT_4000_NS 0x1F
#define	POWERSTEP2_GEN_GATECFG2_TDT_MASK 0x1F
#define	POWERSTEP2_GEN_GATECFG2_MASK 0xFF
#define	POWERSTEP2_GEN_STATUS_STALL_A_MASK 0x8000
#define	POWERSTEP2_GEN_STATUS_STALL_B_MASK 0x4000
#define	POWERSTEP2_GEN_STATUS_OCD_MASK 0x2000
#define	POWERSTEP2_GEN_STATUS_TH_STATUS_MASK 0x1800
#define	POWERSTEP2_GEN_STATUS_UVLO_ADC_MASK 0x0400
#define	POWERSTEP2_GEN_STATUS_UVLO_MASK 0x0200
#define	POWERSTEP2_GEN_STATUS_STCK_MOD_MASK 0x0100
#define	POWERSTEP2_GEN_STATUS_CMD_ERROR_MASK 0x0080
#define	POWERSTEP2_GEN_STATUS_MOT_STATUS_MASK 0x0060
#define	POWERSTEP2_GEN_STATUS_DIR_MASK 0x0010
#define	POWERSTEP2_GEN_STATUS_SW_EVN_MASK 0x0008
#define	POWERSTEP2_GEN_STATUS_SW_F_MASK 0x0004
#define	POWERSTEP2_GEN_STATUS_BUSY_MASK 0x0002
#define	POWERSTEP2_GEN_STATUS_HIZ_MASK 0x0001
#define	POWERSTEP2_GEN_STATUS_MASK 0xFFFF
#define	POWERSTEP2_V_KVAL_HOLD_0_VS 0x00
#define	POWERSTEP2_V_KVAL_HOLD_0_004_VS 0x01
#define	POWERSTEP2_V_KVAL_HOLD_0_008_VS 0x02
#define	POWERSTEP2_V_KVAL_HOLD_0_104_VS 0x19
#define	POWERSTEP2_V_KVAL_HOLD_0_168_VS 0x29
#define	POWERSTEP2_V_KVAL_HOLD_0_996_VS 0xFF
#define	POWERSTEP2_V_KVAL_HOLD_MASK 0xFF
#define	POWERSTEP2_V_KVAL_RUN_0_VS 0x00
#define	POWERSTEP2_V_KVAL_RUN_0_004_VS 0x01
#define	POWERSTEP2_V_KVAL_RUN_0_008_VS 0x02
#define	POWERSTEP2_V_KVAL_RUN_0_104_VS 0x19
#define	POWERSTEP2_V_KVAL_RUN_0_168_VS 0x29
#define	POWERSTEP2_V_KVAL_RUN_0_996_VS 0xFF
#define	POWERSTEP2_V_KVAL_RUN_MASK 0xFF
#define	POWERSTEP2_V_KVAL_ACC_0_VS 0x00
#define	POWERSTEP2_V_KVAL_ACC_0_004_VS 0x01
#define	POWERSTEP2_V_KVAL_ACC_0_008_VS 0x02
#define	POWERSTEP2_V_KVAL_ACC_0_104_VS 0x19
#define	POWERSTEP2_V_KVAL_ACC_0_168_VS 0x29
#define	POWERSTEP2_V_KVAL_ACC_0_996_VS 0xFF
#define	POWERSTEP2_V_KVAL_ACC_MASK 0xFF
#define	POWERSTEP2_V_KVAL_DEC_0_VS 0x00
#define	POWERSTEP2_V_KVAL_DEC_0_004_VS 0x01
#define	POWERSTEP2_V_KVAL_DEC_0_008_VS 0x02
#define	POWERSTEP2_V_KVAL_DEC_0_104_VS 0x19
#define	POWERSTEP2_V_KVAL_DEC_0_168_VS 0x29
#define	POWERSTEP2_V_KVAL_DEC_0_996_VS 0xFF
#define	POWERSTEP2_V_KVAL_DEC_MASK 0xFF
#define	POWERSTEP2_V_INT_SPEED_0_STEP_S 0x0000
#define	POWERSTEP2_V_INT_SPEED_0_0596_STEP_S 0x0001
#define	POWERSTEP2_V_INT_SPEED_0_1192_STEP_S 0x0002
#define	POWERSTEP2_V_INT_SPEED_61_5668_STEP_S 0x0408
#define	POWERSTEP2_V_INT_SPEED_976_5_STEP_S 0x3FFF
#define	POWERSTEP2_V_INT_SPEED_MASK 0x3FFF
#define	POWERSTEP2_V_ST_SLP_0 0x00
#define	POWERSTEP2_V_ST_SLP_0_000015 0x01
#define	POWERSTEP2_V_ST_SLP_0_00003 0x02
#define	POWERSTEP2_V_ST_SLP_0_000135 0x08
#define	POWERSTEP2_V_ST_SLP_0_004 0xFF
#define	POWERSTEP2_V_ST_SLP_MASK 0xFF
#define	POWERSTEP2_V_FN_SLP_ACC_0 0x00
#define	POWERSTEP2_V_FN_SLP_ACC_0_000015 0x01
#define	POWERSTEP2_V_FN_SLP_ACC_0_00003 0x02
#define	POWERSTEP2_V_FN_SLP_ACC_0_000135 0x08
#define	POWERSTEP2_V_FN_SLP_ACC_0_00063 0x29
#define	POWERSTEP2_V_FN_SLP_ACC_0_004 0xFF
#define	POWERSTEP2_V_FN_SLP_ACC_MASK 0xFF
#define	POWERSTEP2_V_FN_SLP_DEC_0 0x00
#define	POWERSTEP2_V_FN_SLP_DEC_0_000015 0x01
#define	POWERSTEP2_V_FN_SLP_DEC_0_00003 0x02
#define	POWERSTEP2_V_FN_SLP_DEC_0_000135 0x08
#define	POWERSTEP2_V_FN_SLP_DEC_0_00063 0x29
#define	POWERSTEP2_V_FN_SLP_DEC_0_004 0xFF
#define	POWERSTEP2_V_FN_SLP_DEC_MASK 0xFF
#define	POWERSTEP2_V_K_THERM_1 0x00
#define	POWERSTEP2_V_K_THERM_1_03125 0x01
#define	POWERSTEP2_V_K_THERM_1_0625 0x02
#define	POWERSTEP2_V_K_THERM_1_46875 0x0F
#define	POWERSTEP2_V_K_THERM_MASK 0x0F
#define	POWERSTEP2_V_STALL_TH_31_25_MV 0x00
#define	POWERSTEP2_V_STALL_TH_62_5_MV 0x01
#define	POWERSTEP2_V_STALL_TH_93_75_MV 0x02
#define	POWERSTEP2_V_STALL_TH_281_25_MV 0x08
#define	POWERSTEP2_V_STALL_TH_531_25_MV 0x10
#define	POWERSTEP2_V_STALL_TH_1000_MV 0x1F
#define	POWERSTEP2_V_STALL_TH_MASK 0x1F
#define	POWERSTEP2_V_CONFIG_F_PWM_INT_19_5_KHZ 0x0000
#define	POWERSTEP2_V_CONFIG_F_PWM_INT_31_3_KHZ 0x0000
#define	POWERSTEP2_V_CONFIG_F_PWM_INT_62_5_KHZ 0x0000
#define	POWERSTEP2_V_CONFIG_F_PWM_INT_MASK 0xE000
#define	POWERSTEP2_V_CONFIG_F_PWM_DEC_19_5_KHZ 0x0000
#define	POWERSTEP2_V_CONFIG_F_PWM_DEC_31_3_KHZ 0x0C00
#define	POWERSTEP2_V_CONFIG_F_PWM_DEC_62_5_KHZ 0x1C00
#define	POWERSTEP2_V_CONFIG_F_PWM_DEC_MASK 0x1C00
#define	POWERSTEP2_V_CONFIG_VCCVAL_7_5_V 0x0000
#define	POWERSTEP2_V_CONFIG_VCCVAL_15_V 0x0200
#define	POWERSTEP2_V_CONFIG_VCCVAL_MASK 0x0200
#define	POWERSTEP2_V_CONFIG_UVLOVAL_LOW 0x0000
#define	POWERSTEP2_V_CONFIG_UVLOVAL_HIGH 0x0100
#define	POWERSTEP2_V_CONFIG_UVLOVAL_MASK 0x0100
#define	POWERSTEP2_V_CONFIG_OC_SD_DISABLE 0x0000
#define	POWERSTEP2_V_CONFIG_OC_SD_ENABLE 0x0080
#define	POWERSTEP2_V_CONFIG_OC_SD_MASK 0x0080
#define	POWERSTEP2_V_CONFIG_EN_VSCOMP_DISABLE 0x0000
#define	POWERSTEP2_V_CONFIG_EN_VSCOMP_ENABLE 0x0020
#define	POWERSTEP2_V_CONFIG_EN_VSCOMP_MASK 0x0020
#define	POWERSTEP2_V_CONFIG_SW_MODE_HARD_STOP_INT 0x0000
#define	POWERSTEP2_V_CONFIG_SW_MODE_USER_DISPOSAL 0x0010
#define	POWERSTEP2_V_CONFIG_SW_MODE_MASK 0x0010
#define	POWERSTEP2_V_CONFIG_EXT_CLK_DISABLE 0x0000
#define	POWERSTEP2_V_CONFIG_EXT_CLK_ENABLE 0x0008
#define	POWERSTEP2_V_CONFIG_EXT_CLK_MASK 0x0008
#define	POWERSTEP2_V_CONFIG_OSC_SEL_INT_16_MHZ 0x0000
#define	POWERSTEP2_V_CONFIG_OSC_SEL_MASK 0x0007
#define	POWERSTEP2_V_CONFIG_MASK 0xFFFF
#define	POWERSTEP2_C_TVAL_HOLD_7_8_MV 0x00
#define	POWERSTEP2_C_TVAL_HOLD_15_6_MV 0x01
#define	POWERSTEP2_C_TVAL_HOLD_202_8_MV 0x19
#define	POWERSTEP2_C_TVAL_HOLD_327_6_MV 0x29
#define	POWERSTEP2_C_TVAL_HOLD_1000_MV 0x7F
#define	POWERSTEP2_C_TVAL_HOLD_MASK 0x7F
#define	POWERSTEP2_C_TVAL_RUN_7_8_MV 0x00
#define	POWERSTEP2_C_TVAL_RUN_15_6_MV 0x01
#define	POWERSTEP2_C_TVAL_RUN_202_8_MV 0x19
#define	POWERSTEP2_C_TVAL_RUN_327_6_MV 0x29
#define	POWERSTEP2_C_TVAL_RUN_1000_MV 0x7F
#define	POWERSTEP2_C_TVAL_RUN_MASK 0x7F
#define	POWERSTEP2_C_TVAL_ACC_7_8_MV 0x00
#define	POWERSTEP2_C_TVAL_ACC_15_6_MV 0x01
#define	POWERSTEP2_C_TVAL_ACC_202_8_MV 0x19
#define	POWERSTEP2_C_TVAL_ACC_327_6_MV 0x29
#define	POWERSTEP2_C_TVAL_ACC_1000_MV 0x7F
#define	POWERSTEP2_C_TVAL_ACC_MASK 0x7F
#define	POWERSTEP2_C_TVAL_DEC_7_8_MV 0x00
#define	POWERSTEP2_C_TVAL_DEC_15_6_MV 0x01
#define	POWERSTEP2_C_TVAL_DEC_202_8_MV 0x19
#define	POWERSTEP2_C_TVAL_DEC_327_6_MV 0x29
#define	POWERSTEP2_C_TVAL_DEC_1000_MV 0x7F
#define	POWERSTEP2_C_TVAL_DEC_MASK 0x7F
#define	POWERSTEP2_C_T_FAST_TOFF_FAST_2_US 0x00
#define	POWERSTEP2_C_T_FAST_TOFF_FAST_4_US 0x10
#define	POWERSTEP2_C_T_FAST_TOFF_FAST_10_US 0x40
#define	POWERSTEP2_C_T_FAST_TOFF_FAST_32_US 0xF0
#define	POWERSTEP2_C_T_FAST_TOFF_FAST_MASK 0xF0
#define	POWERSTEP2_C_T_FAST_FAST_STEP_2_US 0x00
#define	POWERSTEP2_C_T_FAST_FAST_STEP_4_US 0x01
#define	POWERSTEP2_C_T_FAST_FAST_STEP_10_US 0x04
#define	POWERSTEP2_C_T_FAST_FAST_STEP_16_US 0x07
#define	POWERSTEP2_C_T_FAST_FAST_STEP_32_US 0x0F
#define	POWERSTEP2_C_T_FAST_FAST_STEP_MASK 0x0F
#define	POWERSTEP2_C_T_FAST_MASK 0xFF
#define	POWERSTEP2_C_TON_MIN_0_5_US 0x00
#define	POWERSTEP2_C_TON_MIN_1_US 0x01
#define	POWERSTEP2_C_TON_MIN_2_5_US 0x04
#define	POWERSTEP2_C_TON_MIN_64_US 0x7F
#define	POWERSTEP2_C_TON_MIN_MASK 0x7F
#define	POWERSTEP2_C_TOFF_MIN_0_5_US 0x00
#define	POWERSTEP2_C_TOFF_MIN_1_US 0x01
#define	POWERSTEP2_C_TOFF_MIN_2_5_US 0x04
#define	POWERSTEP2_C_TOFF_MIN_21_US 0x29
#define	POWERSTEP2_C_TOFF_MIN_64_US 0x7F
#define	POWERSTEP2_C_TOFF_MIN_MASK 0x7F
#define	POWERSTEP2_C_CONFIG_PRED_EN_DISABLE 0x0000
#define	POWERSTEP2_C_CONFIG_PRED_EN_ENABLE 0x8000
#define	POWERSTEP2_C_CONFIG_PRED_EN_MASK 0x8000
#define	POWERSTEP2_C_CONFIG_TSW_4_US 0x0400
#define	POWERSTEP2_C_CONFIG_TSW_8_US 0x0800
#define	POWERSTEP2_C_CONFIG_TSW_48_US 0x3000
#define	POWERSTEP2_C_CONFIG_TSW_124_US 0x7C00
#define	POWERSTEP2_C_CONFIG_TSW_MASK 0x7C00
#define	POWERSTEP2_C_CONFIG_VCCVAL_7_5_V 0x0000
#define	POWERSTEP2_C_CONFIG_VCCVAL_15_V 0x0200
#define	POWERSTEP2_C_CONFIG_VCCVAL_MASK 0x0200
#define	POWERSTEP2_C_CONFIG_UVLOVAL_LOW 0x0000
#define	POWERSTEP2_C_CONFIG_UVLOVAL_HIGH 0x0100
#define	POWERSTEP2_C_CONFIG_UVLOVAL_MASK 0x0100
#define	POWERSTEP2_C_CONFIG_OC_SD_DISABLE 0x0000
#define	POWERSTEP2_C_CONFIG_OC_SD_ENABLE 0x0080
#define	POWERSTEP2_C_CONFIG_OC_SD_MASK 0x0080
#define	POWERSTEP2_C_CONFIG_EN_TQREG_DISABLE 0x0000
#define	POWERSTEP2_C_CONFIG_EN_TQREG_ENABLE 0x0020
#define	POWERSTEP2_C_CONFIG_EN_TQREG_MASK 0x0020
#define	POWERSTEP2_C_CONFIG_SW_MODE_HARD_STOP_INT 0x0000
#define	POWERSTEP2_C_CONFIG_SW_MODE_USER_DISPOSAL 0x0010
#define	POWERSTEP2_C_CONFIG_SW_MODE_MASK 0x0010
#define	POWERSTEP2_C_CONFIG_EXT_CLK_DISABLE 0x0000
#define	POWERSTEP2_C_CONFIG_EXT_CLK_ENABLE 0x0008
#define	POWERSTEP2_C_CONFIG_EXT_CLK_MASK 0x0008
#define	POWERSTEP2_C_CONFIG_OSC_SEL_INT_16_MHZ 0x0000
#define	POWERSTEP2_C_CONFIG_OSC_SEL_MASK 0x0007
#define	POWERSTEP2_C_CONFIG_MASK 0xFFFF
#define	POWERSTEP2_GEN_ABS_POS_DEF ( POWERSTEP2_GEN_ABS_POS_HOME )
	Power Step 2 parameter register default settings.
#define	POWERSTEP2_GEN_EL_POS_DEF
#define	POWERSTEP2_GEN_MARK_DEF ( POWERSTEP2_GEN_MARK_ZERO )
#define	POWERSTEP2_GEN_ACC_DEF ( POWERSTEP2_GEN_ACC_101_85_STEP_S2 )
#define	POWERSTEP2_GEN_DEC_DEF ( POWERSTEP2_GEN_DEC_101_85_STEP_S2 )
#define	POWERSTEP2_GEN_MAX_SPEED_DEF ( POWERSTEP2_GEN_MAX_SPEED_305_STEP_S )
#define	POWERSTEP2_GEN_MIN_SPEED_DEF
#define	POWERSTEP2_GEN_OCD_TH_DEF ( POWERSTEP2_GEN_OCD_TH_531_25_MV )
#define	POWERSTEP2_GEN_FS_SPD_DEF
#define	POWERSTEP2_GEN_STEP_MODE_DEF
#define	POWERSTEP2_GEN_ALARM_EN_DEF
#define	POWERSTEP2_GEN_GATECFG1_DEF
#define	POWERSTEP2_GEN_GATECFG2_DEF
#define	POWERSTEP2_V_CONFIG_DEF
#define	POWERSTEP2_V_KVAL_HOLD_DEF ( POWERSTEP2_V_KVAL_HOLD_0_168_VS )
#define	POWERSTEP2_V_KVAL_RUN_DEF ( POWERSTEP2_V_KVAL_RUN_0_168_VS )
#define	POWERSTEP2_V_KVAL_ACC_DEF ( POWERSTEP2_V_KVAL_ACC_0_168_VS )
#define	POWERSTEP2_V_KVAL_DEC_DEF ( POWERSTEP2_V_KVAL_DEC_0_168_VS )
#define	POWERSTEP2_V_INT_SPEED_DEF ( POWERSTEP2_V_INT_SPEED_61_5668_STEP_S )
#define	POWERSTEP2_V_ST_SLP_DEF ( POWERSTEP2_V_ST_SLP_0_000135 )
#define	POWERSTEP2_V_FN_SLP_ACC_DEF ( POWERSTEP2_V_FN_SLP_ACC_0_00063 )
#define	POWERSTEP2_V_FN_SLP_DEC_DEF ( POWERSTEP2_V_FN_SLP_DEC_0_00063 )
#define	POWERSTEP2_V_K_THERM_DEF ( POWERSTEP2_V_K_THERM_1 )
#define	POWERSTEP2_V_STALL_TH_DEF ( POWERSTEP2_V_STALL_TH_531_25_MV )
#define	POWERSTEP2_C_CONFIG_DEF
#define	POWERSTEP2_C_TVAL_HOLD_DEF ( POWERSTEP2_C_TVAL_HOLD_327_6_MV )
#define	POWERSTEP2_C_TVAL_RUN_DEF ( POWERSTEP2_C_TVAL_RUN_327_6_MV )
#define	POWERSTEP2_C_TVAL_ACC_DEF ( POWERSTEP2_C_TVAL_ACC_327_6_MV )
#define	POWERSTEP2_C_TVAL_DEC_DEF ( POWERSTEP2_C_TVAL_DEC_327_6_MV )
#define	POWERSTEP2_C_T_FAST_DEF
#define	POWERSTEP2_C_TON_MIN_DEF ( POWERSTEP2_C_TON_MIN_2_5_US )
#define	POWERSTEP2_C_TOFF_MIN_DEF ( POWERSTEP2_C_TOFF_MIN_21_US )
#define	POWERSTEP2_CONTROL_MODE_VOLTAGE 0
	Power Step 2 control mode setting.
#define	POWERSTEP2_CONTROL_MODE_CURRENT 1
#define	POWERSTEP2_STEP_MODE_FULL_STEP 0
	Power Step 2 step mode setting.
#define	POWERSTEP2_STEP_MODE_HALF_STEP 1
#define	POWERSTEP2_STEP_MODE_QUARTER_STEP 2
#define	POWERSTEP2_STEP_MODE_1_OVER_8 3
#define	POWERSTEP2_STEP_MODE_1_OVER_16 4
#define	POWERSTEP2_STEP_MODE_1_OVER_32 5
#define	POWERSTEP2_STEP_MODE_1_OVER_64 6
#define	POWERSTEP2_STEP_MODE_1_OVER_128 7
#define	POWERSTEP2_ACCELERATION_STEP 14.55f
	Power Step 2 acceleration and deceleration settings.
#define	POWERSTEP2_ACCELERATION_MIN 14.55f
#define	POWERSTEP2_ACCELERATION_MAX 59575.541f
#define	POWERSTEP2_DECELERATION_STEP 14.55f
#define	POWERSTEP2_DECELERATION_MIN 14.55f
#define	POWERSTEP2_DECELERATION_MAX 59575.541f
#define	POWERSTEP2_MIN_SPEED_STEP 0.238f
	Power Step 2 speed min and max settings.
#define	POWERSTEP2_MIN_SPEED_MIN 0.0f
#define	POWERSTEP2_MIN_SPEED_MAX 976.3f
#define	POWERSTEP2_MAX_SPEED_STEP 15.25f
#define	POWERSTEP2_MAX_SPEED_MIN 15.25f
#define	POWERSTEP2_MAX_SPEED_MAX 15610.0f
#define	POWERSTEP2_DIR_CW 1
	Power Step 2 direction setting.
#define	POWERSTEP2_DIR_CCW 0
#define	POWERSTEP2_PIN_LOW_LEVEL 0
	Power Step 2 pin logic level setting.
#define	POWERSTEP2_PIN_HIGH_LEVEL 1
#define	POWERSTEP2_SPEED_VERY_SLOW 0
	Power Step 2 driving speed in step clock mode settings.
#define	POWERSTEP2_SPEED_SLOW 1
#define	POWERSTEP2_SPEED_MEDIUM 2
#define	POWERSTEP2_SPEED_FAST 3
#define	POWERSTEP2_SPEED_VERY_FAST 4
#define	POWERSTEP2_ROUND_TO_INT 0.5f
	Power Step 2 round to upper int settings.
#define	POWERSTEP2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	POWERSTEP2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
#define	POWERSTEP2_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	powerstep2_return_value_t { POWERSTEP2_OK = 0 , POWERSTEP2_ERROR = -1 }
	Power Step 2 Click return value data. More...

Functions
void	powerstep2_cfg_setup (powerstep2_cfg_t *cfg)
	Power Step 2 configuration object setup function.
err_t	powerstep2_init (powerstep2_t ctx, powerstep2_cfg_t cfg)
	Power Step 2 initialization function.
err_t	powerstep2_default_cfg (powerstep2_t *ctx)
	Power Step 2 default configuration function.
err_t	powerstep2_spi_transfer (powerstep2_t ctx, uint8_t data_io, uint8_t len)
	Power Step 2 SPI transfer function.
void	powerstep2_set_rst_pin (powerstep2_t *ctx, uint8_t state)
	Power Step 2 set rst pin function.
void	powerstep2_set_step_pin (powerstep2_t *ctx, uint8_t state)
	Power Step 2 set step pin function.
uint8_t	powerstep2_get_busy_pin (powerstep2_t *ctx)
	Power Step 2 get busy pin function.
uint8_t	powerstep2_get_flag_pin (powerstep2_t *ctx)
	Power Step 2 get flag pin function.
void	powerstep2_hw_reset_device (powerstep2_t *ctx)
	Power Step 2 reset device function.
err_t	powerstep2_set_param (powerstep2_t *ctx, uint8_t param, uint32_t data_in)
	Power Step 2 set parameter function.
err_t	powerstep2_get_param (powerstep2_t ctx, uint8_t param, uint32_t data_out)
	Power Step 2 get parameter function.
err_t	powerstep2_run (powerstep2_t *ctx, uint8_t dir, uint32_t speed)
	Power Step 2 run motor function.
err_t	powerstep2_step_clock (powerstep2_t *ctx, uint8_t dir)
	Power Step 2 step clock function.
err_t	powerstep2_move (powerstep2_t *ctx, uint8_t dir, uint32_t n_step)
	Power Step 2 move motor function.
err_t	powerstep2_go_to (powerstep2_t *ctx, uint32_t abs_pos)
	Power Step 2 go to position function.
err_t	powerstep2_go_to_dir (powerstep2_t *ctx, uint8_t dir, uint32_t abs_pos)
	Power Step 2 go to position with direction function.
err_t	powerstep2_go_until (powerstep2_t *ctx, uint8_t act, uint8_t dir, uint32_t speed)
	Power Step 2 go until function.
err_t	powerstep2_release_sw (powerstep2_t *ctx, uint8_t act, uint8_t dir)
	Power Step 2 release switch function.
err_t	powerstep2_go_home (powerstep2_t *ctx)
	Power Step 2 go home function.
err_t	powerstep2_go_mark (powerstep2_t *ctx)
	Power Step 2 go mark function.
err_t	powerstep2_reset_pos (powerstep2_t *ctx)
	Power Step 2 reset position function.
err_t	powerstep2_reset_device (powerstep2_t *ctx)
	Power Step 2 reset device function.
err_t	powerstep2_soft_stop (powerstep2_t *ctx)
	Power Step 2 soft stop function.
err_t	powerstep2_hard_stop (powerstep2_t *ctx)
	Power Step 2 hard stop function.
err_t	powerstep2_soft_hiz (powerstep2_t *ctx)
	Power Step 2 soft HiZ function.
err_t	powerstep2_hard_hiz (powerstep2_t *ctx)
	Power Step 2 hard HiZ function.
err_t	powerstep2_get_status (powerstep2_t ctx, uint16_t status)
	Power Step 2 get status function.
err_t	powerstep2_clear_status (powerstep2_t *ctx)
	Power Step 2 clear status function.
err_t	powerstep2_set_control_mode (powerstep2_t *ctx, uint8_t ctrl_mode)
	Power Step 2 set control mode function.
err_t	powerstep2_set_step_mode (powerstep2_t *ctx, uint8_t step_mode)
	Power Step 2 set step mode function.
err_t	powerstep2_set_acc_dec (powerstep2_t *ctx, float acc_step_s2, float dec_step_s2)
	Power Step 2 set acceleration and deceleration function.
err_t	powerstep2_set_speed (powerstep2_t *ctx, float min_speed, float max_speed)
	Power Step 2 set speed function.
void	powerstep2_drive_motor (powerstep2_t *ctx, uint32_t steps, uint8_t speed)
	Power Step 2 drive motor function.

Detailed Description

This file contains API for Power Step 2 Click Driver.

Enumeration Type Documentation

◆ powerstep2_return_value_t

enum powerstep2_return_value_t

Power Step 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
POWERSTEP2_OK
POWERSTEP2_ERROR

Data Structures

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ powerstep2_return_value_t